Get a kiosk by id

GET 
/kiosks/:id

Get a kiosk by id

Request

Path Parameters

id stringrequired

Header Parameters

x-api-key base64 encodedrequired

Your api key for OneBasket

Responses

200

The request has succeeded.

application/json

Schema

Schema

Id stringrequired

The id of the kiosk

Name stringrequired

The name of the kiosk

Description stringrequired

The description of the kiosk

Address stringrequired

The address of the kiosk

Postcode stringrequired

The postcode of the kiosk

Example (from schema)

{
  "Id": "string",
  "Name": "string",
  "Description": "string",
  "Address": "string",
  "Postcode": "string"
}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

detail stringrequired
extensions objectrequired
instance stringrequired
status numberrequired

Possible values: [400]

title stringrequired

Possible values: [Bad request]

type stringrequired

Example (from schema)

{
  "detail": "string",
  "extensions": {},
  "instance": "string",
  "status": 400,
  "title": "Bad request",
  "type": "string"
}

401

Access is unauthorized.

application/json

Schema

Schema

detail stringrequired
extensions objectrequired
instance stringrequired
status numberrequired

Possible values: [401]

title stringrequired

Possible values: [Unauthorized]

type stringrequired

Example (from schema)

{
  "detail": "string",
  "extensions": {},
  "instance": "string",
  "status": 401,
  "title": "Unauthorized",
  "type": "string"
}

404

The server cannot find the requested resource.

application/json

Schema

Schema

detail stringrequired
extensions objectrequired
instance stringrequired
status numberrequired

Possible values: [404]

title stringrequired

Possible values: [Not Found]

type stringrequired

Example (from schema)

{
  "detail": "string",
  "extensions": {},
  "instance": "string",
  "status": 404,
  "title": "Not Found",
  "type": "string"
}

Loading...